Someone is attempting to deploy a commit to the Sim Team on Vercel.

A member of the Team first needs to authorize it.

PR Summary

Low Risk
Documentation-only changes; risk is limited to potential confusion if any instructions/links are inaccurate or become outdated.

Overview
Adds a new FAQ section to README.md covering what Sim is, licensing/cloud vs self-hosted, and supported model providers.

Expands the README with installation/setup answers (requirements, npx simstudio and Docker Compose commands, local model notes, and Copilot API key configuration) plus a troubleshooting checklist for common Docker/DB/port/workflow issues and quick links for getting help.

^{Reviewed by Cursor Bugbot for commit f5eda6c. Bugbot is set up for automated code reviews on this repo. Configure here.}

Greptile Summary

This PR adds a FAQ and Troubleshooting section to README.md to help new users self-serve common setup questions. The content is generally accurate and well-structured, but the "How do I install Sim?" answer for npx simstudio omits the hard Docker requirement that is already called out in the existing Quickstart section, which could mislead users into attempting the install without Docker.

Confidence Score: 4/5

Safe to merge after fixing the missing Docker prerequisite note in the npx simstudio FAQ answer.

One P1 finding: the FAQ install answer for npx simstudio omits a hard Docker requirement already documented in the Quickstart, which will actively mislead users. All other content is accurate and well-structured.

README.md — specifically the 'How do I install Sim?' FAQ answer around line 196–201

Important Files Changed

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[New User Reads README] --> B{Choose deployment}
    B -->|Cloud| C[sim.ai managed service]
    B -->|Self-hosted| D{Choose method}
    D -->|NPM Package| E[npx simstudio]
    D -->|Docker Compose| F[docker compose up]
    D -->|Manual| G[Bun + PostgreSQL + pgvector]
    E -->|Requires| H[Docker must be installed]
    F -->|Requires| H
    H --> I[App runs on localhost:3000]
    G --> I
    I --> J{Issue?}
    J -->|Port conflict| K[Change port / stop service]
    J -->|DB error| L[Check pgvector / connection string]
    J -->|Copilot| M[Set COPILOT_API_KEY in .env]
    J -->|Workflow issue| N[Check API keys / node connections]

_{Reviews (1): Last reviewed commit: "docs: add FAQ and Troubleshooting sectio..." | Re-trigger Greptile}